Skip to main content

Link Code with Work System Entities

Overview

This article explains how to link code from one system to another using SyncNow. Currently, SyncNow supports linking code from Azure DevOps (Git or TFVC) to Jira or to another Azure DevOps instance or collection.

LCWSE Overview

💡 Usage Examples

  1. Link code from Azure DevOps Git or TFVC to Jira Issues.
  2. Link code from one Azure DevOps instance or collection to another.

To link between systems, include a comment in your commit or pull request message such as:
This is my commit message with entity references #ClickSoft-CLS-123 and #ClickSoft-12345.
Issue IDs can be referenced as #{short DevOps Gate SyncNow system Name}-{Entity ID} or simply #{Entity ID}.

📝 Step-by-Step Instructions

1️⃣ Create a DevOps Gate Process

  1. Navigate to the DevOps Gate page.

  2. Press the Add DevOps Gate Process button.

    Process Button

2️⃣ Configure System Security

  1. In a new browser tab, go to the Systems page.

  2. Press the Edit button for each system included in the Sync Process.

    Edit Button Systems Page

  3. Select your preferred Webhook Security options.

  4. Save the system configuration.

    Systems Configuration

3️⃣ Configure the DevOps Gate Process

  1. Enter a name for the process.
  2. Select the systems from which to receive webhooks and the target system where entities will be updated.

    Currently, only Azure DevOps Server and Azure DevOps Service support the Link to Code action.

  3. Add unique system prefixes. These prefixes help SyncNow recognize the source system and determine which entity should be updated.
  4. Add unique system prefixes for the target system to identify where to add hyperlinks to commits or pull requests.

4️⃣ Subscribe to Code Events

  1. For Azure DevOps systems, select the sub-projects to subscribe to code events:

    • Code Pushed
    • Code Checked In
    • Pull Request Created
    • Pull Request Updated
    • Pull Request Merge Attempted

  2. Select the Link to Code action.

  3. Press the Save button.

DevOps Gate Configuration

  1. Enter the password for the user account configured in step 5.

Webhook Account Password

A new DevOps Gate Process has now been created.

DevOps Gate

🧩 Example Workflow

  1. Create Entities in the Target System
    Create the entities in the target system to which you want to add a remote link.

    Create Entities

  2. Reference Entities in Commit or PR Messages
    In the source system, within the subscribed project, create a commit or pull request with entity keys in the message.

    Check In

  3. Verify Remote Link Added
    Confirm that a remote link has been added to the referenced entities in the target system.

    Remote Link Added

Tip:
Use clear and consistent entity references in your commit and PR messages to ensure accurate linking between code and work system entities.